home *** CD-ROM | disk | FTP | other *** search
/ L' Effet Pommier 3 / L'Effet Pommier - Volume 03.iso / Programmation / Alpha ƒ / Tcl / SystemCode / bibtex.tcl < prev    next >
Text File  |  1995-07-14  |  44KB  |  1,385 lines
  1. ###########################################################################
  2. # bibtex.tcl
  3. # 
  4. # This file contains a package of Tcl routines that add support for using
  5. # and maintaining BibTeX citation databases to Alpha. 
  6. #
  7. # See the accompanying file, "BibTeX Help", for a complete description.
  8. # (Unfortunately, it's a bit out of date right now - stay tuned (WTP 6/95))
  9. # 
  10. ###########################################################################
  11. # Notes: 
  12. # 
  13. # By default, only the required fields are included when a new bib entry 
  14. # is created.  You can select any other set of fields to be used by adding 
  15. # an appropriate entry to the 'myFld' array, following the example for the 
  16. # Article entry, further below.  You shouldn't change the 'rqdFld' or 
  17. # 'optFld' arrays, since these will (some day) be used for syntax checking.
  18. # 
  19. ###########################################################################
  20. # written by Tom Pollard (pollard@cucbs.chem.columbia.edu)
  21. #
  22. # Version History
  23. #
  24. # 2.7  (7/95)   'stdAbbrevs' modeVar added for setting predefined abbrevs
  25. #               month names included as predefined abbrevs
  26. #               'alignEquals' formatting flag added.
  27. # 2.62 (7/95)   field delimiters suppressed if field data is an abbreviation
  28. #               unindexed .bib files are indexed automatically upon opening
  29. # 2.61 (7/95)   fixed "SearchFields" bug.
  30. # 2.6  (6/95)   'zapEmptyFields' flag forces optional fields to be removed 
  31. #                   when reformatting an entry.
  32. #               'markStrings' flag controls whether @string entries are included in 
  33. #                   the marks menu.
  34. #               'descendingYears' flag controls whether sorts are in ascending or 
  35. #                   descending chronological order.
  36. #               Sorts all use the year as either primary or secondary sort key now.
  37. #               'copyCiteKey' command copies the citekey of the current entry to the
  38. #                   clipboard.
  39. #               Cmd-double-clicking implemented to resolve abbreviations and crossrefs.
  40. #               Fixed bug in faster getFields proc (comma-after-last-field problems)  
  41. #               Fixed minor bugs in author sorting.  
  42. # 2.5  (6/95)   Fixed bug in formatEntry, whereby '#' concatenations were lost 
  43. #               formatEntry completely ignores @string entries now
  44. #               Entry-parsing code (getFields, getFldVal) cleaned up,
  45. #                  should also be a little bit faster now.
  46. #               formatAllEntries now starts working from the current entry
  47. # 2.41 (6/95)   Updates for compatibility with revised LaTeX mode
  48. #               Automatic conversion of international characters dropped 
  49. #                   (irreconcilable problems with non-US keyboards).
  50. # 2.4  (5/95)   Fixed bugs in parsing of EndNote-created bib files
  51. # 2.3  (4/95)   International characters converted to TeX codes (optionally).
  52. #               'findEntries' bug fixed (no longer returns multiple hits) 
  53. # 2.2 (12/94)   'formatEntries' won't quote fields that contain "#".
  54. #               'segregateStrings' flag forces string defs to sort to the top.
  55. # 2.11(12/94)   Bug fixes in 'formatAllEntries'.
  56. # 2.1 (12/94)   'countEntries' command added.
  57. #               'formatAllEntries' command added; it's a bit clunky, but more robust
  58. #                   than any quicker alternative I considered.
  59. #               Cross-referenced entries now sort to the bottom in all sorts.
  60. #                'crossref' field now included.
  61. # 2.0  (9/94)   'formatEntry' and 'newEntry' line up fields better.
  62. #                'nextEntry' and 'prevEntry' skip @string defs
  63. #                'formatEntry' automtically goes to next entry afterwards.
  64. #                'sortByCitekey' ignores case of cite keys.
  65. #               'fillColumn' included as default modeVar.
  66. #                'getEntry' alerts user to badly delimited entries.
  67. # 1.9 (9/94)    'getFields' should now correctly parse any legal entry.
  68. #                'language' field now included.
  69. #                Default values for new fields (eg 'language') may be defined
  70. #                'preferBraces' replaced by 'fieldBraces' and 'entryBraces'.
  71. #                line-wrapping is done on reformatted entries.
  72. #                '@string' entries preserved in sorts.
  73. #                text before first entry and after last entry are preserved
  74. #                    by sorts.
  75. # 1.8 (8/94)    "getEntry" now recognizes parens as entry delimiters
  76. # 1.7 (8/94)    Bug fixes and accomodations to latex.tcl v2.2
  77. #               Template insertion streamlined
  78. #                Choose multiple fields at a time from list dialog
  79. # 1.6 (8/94)    "preferBraces" allows braces or quotes to be default for
  80. #                   new or reformatted entries,
  81. #               Menu built using $entryNames and $fieldNames,
  82. #               'sortByAuthors' can now sort using last author first,
  83. #                   and is a bit faster,
  84. #               'formatEntry' rewrites entries in canonical format,
  85. #               More customization of canonical format allowed ('indentString')
  86. #               Bib mode definition adapted to Alpha 5.90.
  87. # 1.5 (7/94)    "sortByAuthors" is now robust (I think),
  88. #               Mode of new windows now set correctly.
  89. # 1.4 (7/94)    Added sorting by authors, but still only semi-functional,
  90. #               Added regexp searching by field,
  91. #               "getEntry" bugs fixed.
  92. # 1.2 (7/94)    Bib mode definition adapted to Alpha 5.85,
  93. #               Added bib-file marking (bibMarkFile),
  94. #               Entry and field creation now controlled by data arrays.
  95. # 1.1 (6/94)    Custom BibTeX icon, 
  96. #               Added simple search capability (matchingEntries).
  97. # 1.0 (9/93)    First stable version.
  98. #
  99. ###########################################################################
  100. # This package was inspired by the LaTeX package (latex.tcl), written by
  101. # 
  102. #    Richard T. Austin  <austin@eecs.umich.edu>  , and (currently),
  103. #    Tom Scavo          <trscavo@syr.edu>
  104. #
  105. ###########################################################################
  106. ############################################################################
  107. # Cause latex.tcl to be loaded by calling a dummy procedure defined in that
  108. # file.  This is necessary to get the TeX menu, and to load the 8-bit ASCII
  109. # to TeX conversion routines.
  110. #
  111. dummyTeX
  112.  
  113. ###########################################################################
  114. # BibTeX Key Bindings.
  115. ###########################################################################
  116. # abbreviations:  <o> = option, <z> = control, <s> = shift, <c> = command
  117. #
  118. bind 'b' <sz>    selectEntry "Bib"
  119. bind 'n' <sz>    nextEntry "Bib"
  120. bind 'p' <sz>    prevEntry "Bib"
  121.  
  122. bind 'f' <sz>    searchFields "Bib"
  123. bind 'm' <sz>    searchEntries "Bib"
  124. bind 'l' <sz>    formatEntry "Bib"
  125.  
  126. # tab stops:
  127. bind    '\t'    nextTabStop    "Bib"
  128. bind    '\t'    <s>     prevTabStop    "Bib"
  129. bind  '\t'  <z>  {nthTabStop 0}  "Bib"
  130. bind  '\t'  <c>  deleteTabStops  "Bib"
  131.  
  132. ###########################################################################
  133. # Data Definitions
  134. ###########################################################################
  135. ###########################################################################
  136. # Define the data arrays that contain the names of the required,
  137. # optional, and preferred fields for each entry type.
  138. #
  139. # The index names of the rqdFld() array _define_ the valid entry types
  140. # recognized by the program.
  141. #
  142. set rqdFld(article) {author title journal year} 
  143. set optFld(article) {volume number pages month note}
  144. set myFld(article) {author title journal volume pages year note} 
  145.  
  146. set rqdFld(book) {author title publisher year} 
  147. set optFld(book) {editor volume number series address edition month note}
  148.  
  149. set rqdFld(booklet) {title} 
  150. set optFld(booklet) {author howpublished address month year note}
  151.  
  152. set rqdFld(conference) {author title booktitle year} 
  153. set optFld(conference) {editor volume number series pages organization publisher address month note}
  154.  
  155. set rqdFld(inBook) {author title chapter publisher year} 
  156. set optFld(inBook) {editor pages volume number series address edition month type note}
  157.  
  158. set rqdFld(inCollection) {author title booktitle publisher year} 
  159. set optFld(inCollection) {editor volume number series type chapter pages address edition month note}
  160.  
  161. set rqdFld(inProceedings) {author title booktitle year} 
  162. set optFld(inProceedings) {editor volume number series pages organization publisher address month note}
  163.  
  164. set rqdFld(manual) {title} 
  165. set optFld(manual) {author organization address edition year month note}
  166.  
  167. set rqdFld(mastersThesis) {author title school year} 
  168. set optFld(mastersThesis) {address month note type}
  169.  
  170. set rqdFld(misc) {} 
  171. set optFld(misc) {author title howpublished year month note}
  172.  
  173. set rqdFld(phdThesis) {author title school year} 
  174. set optFld(phdThesis) {address month type note}
  175.  
  176. set rqdFld(proceedings) {title year} 
  177. set optFld(proceedings) {editor volume number series publisher organization address month note}
  178.  
  179. set rqdFld(techReport) {author title institution year} 
  180. set optFld(techReport) {type number address month note}
  181.  
  182. set rqdFld(unpublished) {author title note} 
  183. set optFld(unpublished) {year month}
  184.  
  185. set entryNames [lsort [array names rqdFld]]
  186. set customEntries [lsort [array names myFld]]
  187.  
  188. ###########################################################################
  189. # Define an array of flags indicating whether the data a given field
  190. # type should be quoted.  The actual characters used to quote the field are
  191. # given by $bibOpenQuote and $bibCloseQuote, which are set by the routine
  192. # 'bibFieldDelims' according to the flag $fieldBraces.
  193. #
  194. # Note that the index names of the useBrace() array _define_ the valid 
  195. # field types recognized by the program.
  196. #
  197. set useBrace(address)    1
  198. set useBrace(annote)    1
  199. set useBrace(author)     1
  200. set useBrace(booktitle)    1
  201. set useBrace(chapter)    0
  202. set useBrace(crossref)    1
  203. set useBrace(edition)    1
  204. set useBrace(editor)    1
  205. set useBrace(howpublished)    1
  206. set useBrace(institution)    1
  207. set useBrace(journal)    1
  208. set useBrace(key)    1
  209. set useBrace(language)    1
  210. set useBrace(month)    1
  211. set useBrace(note)    1
  212. set useBrace(number)    0
  213. set useBrace(organization)    1
  214. set useBrace(pages)    0
  215. set useBrace(publisher)    1
  216. set useBrace(school)    1
  217. set useBrace(series)    1
  218. set useBrace(title)    1
  219. set useBrace(type)    1
  220. set useBrace(volume)    0
  221. set useBrace(year)    0
  222.  
  223. set fieldNames [lsort [array names useBrace]]
  224. ###########################################################################
  225. # Default values for newly created fields
  226. #
  227. set defFldVal(language) "german"
  228.  
  229. set fieldDefs [lsort [array names defFldVal]]
  230.  
  231. ###########################################################################
  232. # Search patterns for entries and cite-keys
  233. #
  234. #     set bibTopPat {^[     ]*@[a-zA-Z]+[\{\(]([-A-Za-z0-9_:/\.]+)}
  235. # match entry type
  236. set bibTopPat {^[     ]*@([a-zA-Z]+)[\{\(]}
  237. # match cite-key
  238. set bibTopPat1 {^[     ]*@[a-zA-Z]+[\{\(][     ]*([^=,     ]+)}    
  239. # match type and cite-key
  240. set bibTopPat2 {^[     ]*@([a-zA-Z]+)[\{\(][     ]*([^=,     ]+)}    
  241. # match first field (no cite-key)
  242. set bibTopPat3 {^[     ]*@([a-zA-Z]+)[\{\(]([     ]*[a-zA-Z]+[     ]*=[     ]*)}    
  243.                                                                 
  244.  
  245. ###########################################################################
  246. # BibTeX-mode mode definition
  247. ###########################################################################
  248. newModeVar Bib suffixString    { \\\\} 0
  249. newModeVar Bib prefixString    {% } 0
  250. newModeVar Bib fillColumn    {65} 0
  251. newModeVar Bib wordWrap        {0} 1
  252. newModeVar Bib autoMark        {1} 1
  253.  
  254. newModeVar Bib wordBreak         {[a-zA-Z0-9]+} 0
  255. newModeVar Bib wordBreakPreface     {[^a-zA-Z0-9]} 0
  256. newModeVar Bib funcExpr           $bibTopPat 0
  257.  
  258. newModeVar Bib overwriteBuffer {1} 1
  259. newModeVar Bib fieldBraces {1} 1
  260. newModeVar Bib entryBraces {1} 1
  261. newModeVar Bib segregateStrings {1} 1
  262. newModeVar Bib markStrings {0} 1
  263. newModeVar Bib alignEquals {0} 1
  264. ###
  265. # newModeVar Bib emacsBibMode {0} 1
  266. # newModeVar Bib addCiteKeys {0} 1
  267. # newModeVar Bib checkSyntax {0} 1
  268. newModeVar Bib zapEmptyFields {0} 1
  269. newModeVar Bib descendingYears {1} 1
  270. ###
  271. newModeVar Bib indentString {   } 0
  272. newModeVar Bib stdAbbrevs {jan feb mar apr may jun jul aug sep oct nov dec} 0
  273. # newModeVar Bib convert8bitAscii2TeX {0} 1
  274.  
  275. set bibtexKeyWords {address annote author booktitle 
  276.     chapter city crossref edition editor howpublished institution 
  277.     journal key language month note number organization 
  278.     publisher pages school series title type 
  279.     volume year}
  280. regModeKeywords -e {%} -m {@} -c red -k blue Bib $bibtexKeyWords
  281. unset bibtexKeyWords
  282.  
  283. # # Use a shadow proc to keep settings for 8-bit character conversion 
  284. # # consistent between TeX and Bib modes. 
  285. # #
  286. # trace variable BibmodeVars(convert8bitAscii2TeX) w shadowBib8bitConvert
  287. # proc shadowBib8bitConvert {name1 name2 op} {
  288. #     global BibmodeVars TeXmodeVars
  289. # 
  290. #     # Use TeX-mode routines to actually do the key bindings. 
  291. #     #
  292. #     if {$BibmodeVars(convert8bitAscii2TeX)} then {
  293. #         toggle8bitAscii "ascii" "Bib"
  294. #     } else {
  295. #         toggle8bitAscii "unascii" "Bib"
  296. #     }
  297. #     
  298. #     # Only set TeX flag if necessary, to avoid unnecessary rebinding of keys
  299. #     # (It takes enough time to be annoying)
  300. #     #
  301. #     if {$BibmodeVars(convert8bitAscii2TeX) != $TeXmodeVars(convert8bitAscii2TeX)} then {
  302. #         set TeXmodeVars(convert8bitAscii2TeX) $BibmodeVars(convert8bitAscii2TeX)
  303. #     }
  304. # }
  305. # 
  306. # set BibmodeVars(convert8bitAscii2TeX) $TeXmodeVars(convert8bitAscii2TeX)
  307.  
  308. ###########################################################################
  309. # BibTeX Menu Definition.
  310. ###########################################################################
  311. proc bibtexMenu {} {}
  312.  
  313. set bibtexMenu "Ñ136"
  314.  
  315. proc bibtex {} {
  316.     global bibtexPath
  317.     set name [checkRunning BibTeX BIBt bibtexPath]
  318.     if {![string length $name]} return
  319.     switchTo $name
  320. }
  321.  
  322. proc makeindex {} {
  323.     global makeindexPath
  324.     set name [checkRunning MakeIndex Midx makeindexPath]
  325.     if {![string length $name]} return
  326.     switchTo $name
  327. }
  328.  
  329. menu -n $bibtexMenu {
  330.     "bibtex"
  331.     "(-)"  
  332.     {menu -n Entries -p makeEntry {}
  333.     }
  334.     {menu -n Fields -p makeField {}
  335.     }
  336.     "(-)"
  337.     "selectEntry/B<U<B"
  338.     "nextEntry/N<U<B"
  339.     "prevEntry/P<U<B"
  340.     "formatEntry/L<U<B"
  341.     "copyCiteKey/C<U<B"
  342.     "(-)"
  343.     "searchEntries/M<U<B"
  344.     "searchFields/F<U<B"
  345.     {menu -n sortBy... -p bibSortProc {
  346.         "citeKey"
  347.         "firstAuthor,Year"
  348.         "lastAuthor,Year"
  349.         "year,FirstAuthor"
  350.         "year,LastAuthor"
  351.         }
  352.     }
  353.     {menu -n sortMarks... -p markSortProc {
  354.         "alphabetically"
  355.         "byPosition"
  356.         }
  357.     }
  358.     "(-)"
  359.     "countEntries"
  360.     "formatAllEntries"
  361. } 
  362.     
  363. menu -n Entries -p makeEntry [concat $entryNames {
  364.         "(-)"
  365.         "customEntry"
  366.         } ]
  367.  
  368. menu -n Fields -p makeField [concat $fieldNames {
  369.         "(-)"
  370.         "customField"
  371.         "multipleFields"
  372.         } ]
  373.         
  374. ###########################################################################
  375. # Menu command procs
  376. ###########################################################################
  377.         
  378. proc makeField {menu item} {
  379.     global fieldNames
  380.     bibFormatSetup
  381.     
  382.     if {$item == "multipleFields"} then {
  383.         set flds [listpick -l -L {author year} -p "Pick desired fields:" $fieldNames]
  384.         if {[llength flds]} {
  385.             set lines {}
  386.             foreach fld $flds {
  387.                 append lines [newField $fld]
  388.             }
  389.         } else {
  390.             return
  391.         }
  392.     } else {
  393.         set lines [newField $item]
  394.     }
  395.     
  396.     set pos0 [nextLineStart [getPos]]
  397.     goto $pos0
  398.     insertText $lines
  399.     goto $pos0
  400.     nextTabStop
  401. }
  402.  
  403. proc makeEntry {menu item} {
  404.     bibFormatSetup
  405.     newEntry $item
  406. }
  407.  
  408. ###########################################################################
  409. #  Return the bounds of the bibliographic entry surrounding the current 
  410. #  position.
  411. #
  412. proc getEntry {pos} {
  413.     
  414.      set pos1 [search -f 0 -r 1 -n -s {[     ]*@[a-zA-Z]*[\{\(]} $pos ]
  415.     if {$pos1 == ""} then {
  416.         set begPos [nextLineStart $pos]
  417.         set endPos $begPos
  418.     } else {
  419.         set begPos [lineStart [lindex $pos1 0]]
  420.         set pos0 [lindex $pos1 1]
  421.         set openBrace [getText [expr $pos0-1] $pos0 ]
  422.         if {[catch {matchIt $openBrace $pos0]} pos1]} {
  423.             alertnote "There seems to be a badly delimited field in here.  Are entry and field delimiters set correctly?"
  424.             goto $begPos
  425.             error "Can't find close brace"
  426.         } else {
  427.             set endPos [nextLineStart $pos1]
  428.         }
  429.     }
  430.     return [list $begPos $endPos]
  431. }
  432.  
  433. ###########################################################################
  434. #  Advance to the next bibliographic entry.
  435. #
  436. proc nextEntry {} {
  437.     global bibTopPat bibTopPat1 bibTopPat2
  438. #     set topPat {[     ]*@([a-zA-Z]+)[\{\(]}
  439.     
  440.     set pos0 [lindex [getEntry [getPos]] 1]
  441.     set nextPos [nextLineStart $pos0]
  442.     
  443.     while {![catch {search -f 1 -r 1 -s $bibTopPat $pos0} pos]} {
  444.         regexp $bibTopPat [eval getText $pos] mtch type
  445.         if {$type != "string"} {
  446.             set nextPos [lindex $pos 0]
  447.             break
  448.         } else {
  449.             set pos0 [nextLineStart [lindex $pos 1]]
  450.         }
  451.     }
  452.     goto $nextPos
  453. }
  454.  
  455. ###########################################################################
  456. #  Go back to the previous bibliographic entry.
  457. #
  458. proc prevEntry {} {
  459.     global bibTopPat bibTopPat1 bibTopPat2
  460. #     set topPat {[     ]*@([a-zA-Z]+)[\{\(]}
  461.     
  462.     set pos0 [lindex [getEntry [getPos]] 0]
  463.     if {$pos0 > 0} {
  464.         set nextPos $pos0
  465.         incr pos0 -1
  466.         while {![catch {search -f 0 -r 1 -s $bibTopPat $pos0} pos]} {
  467.             regexp $bibTopPat [eval getText $pos] mtch type
  468.             if {$type != "string"} {
  469.                 set nextPos [lindex $pos 0]
  470.                 break
  471.             } else {
  472.                 set pos0 [lineStart [lindex $pos 0]]
  473.                 if {$pos0 == 0} {break}
  474.                 incr pos0 -1
  475.             }
  476.         }
  477.         goto $nextPos
  478.     }
  479. }
  480.  
  481. ###########################################################################
  482. #  Select (highlight) the current bibliographic entry.
  483. #
  484. proc selectEntry {} {
  485.     set pos [getEntry [getPos]]
  486.     select [lindex $pos 0] [lindex $pos 1]
  487. }
  488.  
  489. ###########################################################################
  490. #  Put the cite-key of the current entry on the clipboard.
  491. #
  492. proc copyCiteKey {} {
  493.     global bibTopPat2
  494.     set limits [getEntry [getPos]]
  495.     set top [lindex $limits 0]
  496.     set bottom [lindex $limits 1]
  497.     if {[regexp -indices $bibTopPat2 [getText $top $bottom] allofit type citekey]} {
  498.         select [expr $top+[lindex $citekey 0]] [expr $top+[lindex $citekey 1]+1]
  499.         copy
  500.         message "Copied \"[getSelect]\""
  501.     } 
  502. }
  503.  
  504. ###########################################################################
  505. #  Create a new bibliographic entry with its required fields.
  506. #
  507. proc newEntry {entryName} {    
  508.     global  entryNames customEntries fieldNames rqdFld optFld myFld defFldVal
  509.     global bibOpenEntry bibCloseEntry BibmodeVars
  510.     goto [lindex [getEntry [getPos]] 1]
  511.     if {$entryName == "customEntry"} {
  512.         set lines "@Ñ$bibOpenEntryÑ,\r"
  513.         set theFields [listpick -l -L {author} -p "Pick desired fields:" $fieldNames]
  514.     } else {
  515.         set lines "@${entryName}$bibOpenEntryÑ,\r"
  516.         if {[lsearch -exact $customEntries $entryName] >= 0 && [llength $myFld($entryName)]} {
  517.             set theFields $myFld($entryName)
  518.         } elseif {[lsearch -exact $entryNames $entryName] >= 0} {
  519.             set theFields $rqdFld($entryName)
  520.         } else {
  521.             set theFields {}
  522.         }
  523.     }
  524.     set nmlen 0
  525.     foreach field $theFields {
  526.         set len [string length $field]
  527.         if {$len > $nmlen} {set nmlen $len}        
  528.     }
  529.     set theTop [lineStart [getPos]]
  530.     foreach field $theFields {
  531.         catch {append lines [newField $field $nmlen]}
  532.     }
  533.     append lines "$bibCloseEntry\r"
  534.     insertText $lines
  535.     goto $theTop
  536.     nextTabStop
  537. }
  538.  
  539. ###########################################################################
  540. #  Create a new field within the current bibliographic entry
  541. #
  542. proc newField {fieldName {nmlen 0}} {    
  543.     global fieldNames useBrace bibOpenQuote bibCloseQuote bibIndent
  544.     global fieldDefs defFldVal
  545.     set spc "                   "
  546.     if {[lsearch -exact $fieldNames $fieldName] >= 0} {
  547.         set needBraces $useBrace($fieldName)
  548.     } else {
  549.         set needBraces 1
  550.     }
  551.     
  552.     if {[lsearch -exact $fieldDefs $fieldName] >= 0} {
  553.         set val $defFldVal($fieldName)
  554.     } else {
  555.         set val "Ñ"
  556.     }
  557.     
  558.     if {$nmlen} {
  559.         set pad [string range $spc 1 [expr $nmlen - [string length $fieldName]]]
  560.     } else {
  561.         set pad ""
  562.     }            
  563.     if {$needBraces || $fieldName == "customField"} {
  564.         set result "$bibIndent$fieldName =$pad ${bibOpenQuote}${val}${bibCloseQuote},\r"
  565.     } else {
  566.         set result "$bibIndent$fieldName =$pad $val,\r"
  567.     }    
  568.     return $result
  569. }
  570.  
  571. proc bibFormatSetup {} {
  572.     global bibOpenQuote bibCloseQuote bibIndent BibmodeVars
  573.     global bibOpenEntry bibCloseEntry bibAbbrevs
  574.     bibFieldDelims
  575.     bibEntryDelims
  576.     set bibIndent $BibmodeVars(indentString)
  577.     regsub {\\t} $bibIndent {    } bibIndent
  578.     set bibAbbrevs [listStrings]
  579.     foreach abbrev $BibmodeVars(stdAbbrevs) {
  580.         lappend bibAbbrevs [string tolower $abbrev]
  581.     }
  582. }
  583.  
  584. ###########################################################################
  585. #  Find all entries that match a given regular expression and copy them to 
  586. #  a new buffer.
  587. #
  588. proc searchEntries {} {
  589.     if [catch {prompt "Regular expression:" ""} reg] return
  590.     if {![string length $reg]} return
  591.     set reg ^.*$reg.*$
  592.     
  593.     set matches [findEntries $reg]
  594.     if {[llength $matches] >0} {
  595.         writeEntries $matches 0
  596.     } else {
  597.         message "No matching entries were found"
  598.     }
  599. }
  600.  
  601. ###########################################################################
  602. #  Find all entries in which the indicated field matches a given regular 
  603. #  expression and copy them to a new buffer.  
  604. #
  605. proc searchFields {} {
  606.     global fieldNames
  607.     if {[catch {eval prompt {{Field name:}} "author" {Fields} $fieldNames} fld]} return
  608.     if {![string length $fld]} return
  609.  
  610.     if {[catch {prompt "Regular expression:" ""} reg]} return
  611.     if {![string length $reg]} return
  612.  
  613.     set matches [findEntries $reg]
  614.     if {[llength $matches] == 0} {
  615.         return "No matching entries were found"
  616.     }
  617.     
  618.     set vals {}
  619.     foreach hit $matches {
  620.         set pos [lindex $hit 1]
  621.         set top [lindex $hit 2] 
  622.         set bottom [lindex $hit 3]
  623.         while {[set failure [expr {[getFldName $pos $top] != $fld}]]  && 
  624.             ![catch {search -f 1 -r 1 -i 1 -m 0 -l $bottom -s -- $reg $pos} mtch]} {
  625.             set pos [lindex $mtch 1]
  626.         }
  627.         if {!$failure} { lappend vals [list $top $bottom] }
  628.     }
  629.     
  630.     if {[llength $vals] >0} {
  631.         writeEntries $vals 0
  632.     } else {
  633.         message "No matching entries were found"
  634.     }
  635.     
  636. }
  637.  
  638. ###########################################################################
  639. # Sort all of the entries based on one of various criteria.
  640. #
  641. proc bibSortProc {menu item} {
  642.     if {$item == "citeKey"} {
  643.         sortByCiteKey
  644.     } elseif  {$item == "firstAuthor,Year"} {
  645.         sortByAuthors 0 0
  646.     } elseif  {$item == "lastAuthor,Year"} {
  647.         sortByAuthors 1 0
  648.     } elseif  {$item == "year,FirstAuthor"} {
  649.         sortByAuthors 0 1
  650.     } elseif  {$item == "year,LastAuthor"} {
  651.         sortByAuthors 1 1
  652.     }
  653. }
  654.  
  655. ###########################################################################
  656. # Sort the file marks. (These operations are also available under the
  657. # "Search:NamedMarks" menu)
  658. #
  659. proc markSortProc {menu item} {
  660.     if {$item == "alphabetically"} {
  661.         sortMarksFile
  662.     } elseif  {$item == "byPosition"} {
  663.         orderMarks
  664.     }
  665. }
  666.  
  667. ###########################################################################
  668. # Sort all of the entries in the file alphabetically by author.
  669. #
  670. proc sortByAuthors {{lastAuthorFirst 0} {yearFirst 0}} {
  671.     global bibTopPat bibTopPat1 bibTopPat2 BibmodeVars
  672.     set bibSegStr $BibmodeVars(segregateStrings)
  673.     
  674.     set matches [findEntries $bibTopPat]
  675.     set crossrefs [listCrossrefs]
  676.     set strings [listStrings]
  677.     
  678.     set vals {}
  679.     set others {}
  680.     set refs {}
  681.     set strs {}
  682.     
  683.     set beg [maxPos]
  684.     set end 0
  685.     
  686.     foreach hit $matches {
  687.         set pos [lindex $hit 1]
  688.         set top [lindex $hit 2] 
  689.         set bottom [lindex $hit 3]
  690.         set entry [getText $top $bottom]
  691.         regsub -all "\[\n\r\]+" $entry { } entry
  692.         regsub -all "\[     \]\[     \]+" $entry { } entry
  693.         regsub {[,     ]*[\)\}][     ]*$} $entry { } entry
  694.         if {[regexp $bibTopPat1 $entry allofit citeKey]} {
  695.             set citeKey [string tolower $citeKey]
  696.             set keyExists 1
  697.         } else {
  698.             set citekey ""
  699.             set keyExists 0
  700.         }
  701.         
  702.         if {$keyExists && [lsearch -exact $crossrefs $citeKey] >= 0} {
  703.             lappend refs [list $pos $top $bottom]
  704.         } elseif {$bibSegStr && $keyExists && [lsearch -exact $strings $citeKey] >= 0} {
  705.             lappend strs [list $citeKey $top $bottom]        
  706.         } else {
  707.             if {![catch {getFldValue $entry author} fldval]} {
  708.                 if {[catch {getFldValue $entry year} year]} { set year 9999 }
  709.                 lappend vals [list [authSortKey $fldval $lastAuthorFirst $year $yearFirst] $top $bottom]
  710.             } else {
  711.                 lappend others [list $pos $top $bottom]
  712.             }
  713.         }
  714.         if {$top < $beg} {set beg $top}
  715.         if {$bottom > $end} {set end $bottom}
  716.     }
  717.     
  718.     if {$bibSegStr} {
  719.         set result [concat $strs $others [lsort $vals] $refs]
  720.     } else {
  721.         set result [concat $others [lsort $vals] $refs]
  722.     }
  723.     
  724.     if {[llength $result] >0} {
  725.         writeEntries $result 1 $beg $end
  726.     } else {
  727.         message "No results of author sort !!??"
  728.     }
  729. }
  730.  
  731. ###########################################################################
  732. # Return a list of the cite-keys of all cross-referenced entries.
  733. #
  734. proc listStrings {} {
  735.     global bibTopPat bibTopPat1 bibTopPat2
  736.     set matches [findEntries {^[    ]*@string *[\{\(]} 0]
  737.  
  738.     message "scanning for @strings╔"
  739.     foreach hit $matches {
  740.         set top [lindex $hit 2] 
  741.         set bottom [lindex $hit 3]
  742.         set entry [getText $top $bottom]
  743.         regsub -all "\[\n\r\]+" $entry { } entry
  744.         regsub -all "\[     \]\[     \]+" $entry { } entry
  745.         regsub {[,     ]*[\)\}][     ]*$} $entry { } entry
  746.         regexp $bibTopPat1 $entry allofit citekey
  747.         set citekey [string tolower $citekey]
  748.         if {[catch {incr strings($citekey)} num]} {
  749.             set strings($citekey) 1
  750.         }
  751.     }
  752.     if {[catch {lsort [array names strings]} res]} {
  753.         set res {}
  754.     }
  755.     message ""
  756.     return $res
  757. }
  758.  
  759. ###########################################################################
  760. # Return a list of the cite-keys of all cross-referenced entries.
  761. #
  762. proc listCrossrefs {} {
  763.     set matches [findEntries {crossref}]
  764.     catch {unset crossrefs}
  765.  
  766.     message "scanning for crossrefs╔"
  767.     foreach hit $matches {
  768.         set top [lindex $hit 2] 
  769.         set bottom [lindex $hit 3]
  770.         set entry [getText $top $bottom]
  771.         regsub -all "\[\n\r\]+" $entry { } entry
  772.         regsub -all "\[     \]\[     \]+" $entry { } entry
  773.         regsub {[,     ]*[\)\}][     ]*$} $entry { } entry
  774.         if {![catch {getFldValue $entry crossref} fldval]} {
  775.             set fldval [string tolower $fldval]
  776.             if {[catch {incr crossref($fldval)} num]} {
  777.                 set crossrefs($fldval) 1
  778.             }
  779.         }
  780.     }
  781.     if {[catch {lsort [array names crossrefs]} res]} {
  782.         set res {}
  783.     }
  784.     message ""
  785.     return $res
  786. }
  787.  
  788. ###########################################################################
  789. # Create a sort key from an author list.  When sorting entries by author, 
  790. # performing the sort using keys should be faster than reparsing the author 
  791. # lists for every comparison (the old method :-( ).
  792. #
  793. proc authSortKey {authList lastAuthorFirst {year {}} {yearFirst 0}} {
  794.     global BibmodeVars
  795.     set pat1 {\\.\{([A-Za-z])\}}
  796.     set pat2 {\{([^\{\}]+) ([^\{\}]+)\}}
  797.  
  798. # Remove enclosing braces, quotes, or whitespace
  799.     set auths %[string trim $authList {{}"     }]&
  800. # Remove TeX codes for accented characters
  801.     regsub -all $pat1 $auths {\1} auths
  802. # Concatenate strings enclosed in braces
  803.     while {[regsub -all $pat2 $auths {{\1\2}} auths]} {}
  804. # Remove braces (curly and square)
  805.     regsub -all {[][\{\}]} $auths {} auths
  806. #    regsub -all {,} $auths { ,} auths
  807. # Replace 'and's with begin-name/end-name delimiters
  808.     regsub -all {[     ]and[     ]} $auths { \&% } auths
  809. # Put last name first in name fields without commas
  810.     regsub -all {%([^\&,]+) ([^\&, ]+) *\&} $auths {%\2,\1\&} auths
  811. # Remove begin-name delimiters
  812.     regsub -all {%} $auths {} auths
  813. # Remove whitespace surrounding name separators
  814.     regsub -all {[     ]*\&[     ]*} $auths {\&} auths
  815. # Replace whitespace separating words with shrieks 
  816.     regsub -all {[     ,]+} $auths {!} auths
  817. # If desired, move last author to head of sort key
  818.     if {$lastAuthorFirst} {
  819.         regsub {(.*)&([^&]+)&?$} $auths {\2\&\1} auths
  820.     }
  821. # If provided, sort by year (descending order) as well
  822.     regsub {^[^0-9]*([0-9]*).*$} $year {\1} year
  823.     if {$year != {}} {
  824.         if {$BibmodeVars(descendingYears)} { catch {set year [expr 9999-$year]} }
  825.         if {$yearFirst} {
  826.             set auths "$year&$auths"
  827.         } else {        
  828.             regsub {^([^&]+)(&?)} $auths "\\1\\&${year}\\2" auths
  829.         }
  830.     }
  831.         
  832.     return $auths
  833. }
  834.  
  835. ###########################################################################
  836. # Sort all of the entries in the file alphabetically by their cite-keys.
  837. #
  838. proc sortByCiteKey {} {
  839.     global bibTopPat bibTopPat1 bibTopPat2 BibmodeVars
  840.     set bibSegStr $BibmodeVars(segregateStrings)
  841.     
  842.     set matches [findEntries $bibTopPat]
  843.     set crossrefs [listCrossrefs]
  844.     set strings [listStrings]
  845.  
  846.     set begEntries [maxPos]
  847.     set endEntries 0
  848.     
  849.     set strs {}
  850.     set vals {}
  851.     set refs {}
  852.         
  853.     foreach hit $matches {
  854.         set beg [lindex $hit 0]
  855.         set end [lindex $hit 1]
  856.         set top [lindex $hit 2] 
  857.         set bottom [lindex $hit 3]
  858.         if {[regexp $bibTopPat1 [getText $top $bottom] allofit citekey]} {
  859.             set citekey [string tolower $citekey]
  860.             set keyExists 1
  861.         } else {
  862.             set citekey "000000$beg"
  863.             set keyExists 0
  864.         }
  865.         
  866.         if {$keyExists && [lsearch -exact $crossrefs $citekey] >= 0} {
  867.             lappend refs [list $top $top $bottom]
  868.         } elseif {$keyExists && $bibSegStr && [lsearch -exact $strings $citekey] >= 0} {
  869.             lappend strs [list $citekey $top $bottom]        
  870.         } else {
  871.             lappend vals [list $citekey $top $bottom]
  872.         }
  873.  
  874.         if {$top < $begEntries} {set begEntries $top}
  875.         if {$bottom > $endEntries} {set endEntries $bottom}
  876.     }
  877.  
  878.     if {$bibSegStr} {
  879.         set result [concat $strs [lsort $vals] $refs]
  880.     } else {
  881.         set result [concat [lsort $vals] $refs]
  882.     }
  883.     
  884.     if {[llength $result] >0} {
  885.         writeEntries $result 1 $begEntries $endEntries
  886.     } else {
  887.         message "No results of cite-key sort !!??"
  888.     }
  889. }
  890.  
  891. ###########################################################################
  892. # Search for all entries matching a given regular expression.  The results
  893. # are returned in a list, each element of which is a list of four integers:
  894. # the beginning and end of the matching entry and the beginning and end of
  895. # the matching string.  Adapted from "matchingLines" in "misc.tcl".
  896. #
  897. proc findEntries {reg {casesen 1}} {
  898.     if {![string length $reg]} return
  899.     
  900.     set pos 0   
  901.     set result {}                             
  902.     while {![catch {search -f 1 -r 1 -m 0 -i $casesen -s $reg $pos} mtch]} {
  903.         set entry [getEntry [lindex $mtch 0]]
  904.         lappend result [concat $mtch $entry]
  905.         set pos [lindex $entry 1]
  906.     }
  907.     return $result
  908. }
  909.  
  910. ###########################################################################
  911. #  Return a list containing the data for the current entry, indexed by
  912. #  the parameter names, e.g., "author", "year", etc.  Index names for the 
  913. #  entry type and cite-key are "type" and "citekey". 
  914. #
  915. proc getFields {pos} {
  916.      global bibTopPat bibTopPat1 bibTopPat2 bibTopPat3                                                                                                                    ░La Cie 191:Writing ─:Alpha 6.0b20 ─:Tcl:SystemCode:bibtex.tcl
  917.     set fldPat {[     ]*([a-zA-Z]+)[     ]*=[     ]*}
  918.  
  919.     set limits [getEntry $pos]
  920.     set top [lindex $limits 0]
  921.     set bottom [lindex $limits 1]
  922.     
  923.     set entry [getText $top $bottom]
  924.     regsub -all "\[\n\r\]+" $entry { } entry
  925.     regsub -all "\[     \]\[     \]+" $entry { } entry
  926. #
  927.     regsub {[,     ]*[\)\}][     ]*$} $entry { } entry
  928.  
  929.     if {[regexp -indices $bibTopPat2 $entry mtch theType theKey ]} {
  930.         set key [string range $entry [lindex $theKey 0] [lindex $theKey 1]]
  931.         set theRest [expr 1 + [lindex $mtch 1]]
  932.     } elseif {[regexp -indices $bibTopPat3 $entry mtch theType aField]} {
  933.         set key {}
  934.         set theRest [lindex $aField 0]
  935.     } else {
  936.         error "Invalid entry"
  937.     }
  938.     lappend names type
  939.     set type [string tolower [string range $entry [lindex $theType 0] [lindex $theType 1]]]
  940.     lappend data [list $type]
  941.  
  942.     lappend names citekey
  943.     lappend data $key
  944.     
  945.     set entry ",[string range $entry $theRest end]"
  946.     set fldPat {,[     ]*([^ =,]+)[     ]*=[     ]*}
  947.     set name {}
  948.     while {[regexp -indices $fldPat $entry mtch sub1]} {
  949.         set nextName [string range $entry [lindex $sub1 0] [lindex $sub1 1]]
  950.         lappend names [string tolower $nextName]
  951.         if {$name != ""} { 
  952.             set prevData [string range $entry 0 [expr [lindex $mtch 0]-1]]
  953.             lappend data [breakIntoLines [bibFieldData $prevData]]
  954.         }    
  955.         set name $nextName
  956.         set entry [string range $entry [expr [lindex $mtch 1]+1] end]
  957.     }
  958.  
  959.     lappend data [breakIntoLines [bibFieldData $entry]]
  960.     
  961.     return [list $names $data]
  962. }
  963.  
  964. proc bibFieldData {text} {
  965.     set text [string trim $text {     ,#}]
  966.     set text1 [string trim $text {\{\}\"     }]            
  967.     
  968.     if {[string match {*[\{\}\"]*} $text1]} {
  969.         set words [parseWords $text]
  970.         if {[llength $words]==1} {
  971.             regsub {^[\{\"\']} $text {} text
  972.             regsub {[\}\"\']$} $text {} text
  973.         }
  974.     } else {
  975.         set text $text1            
  976.     }
  977.     return $text
  978. }
  979.  
  980.  
  981. ###########################################################################
  982. # Extract the data from the indicated field of an entry, which is passed 
  983. # as a single string.  This version tries to be completely general, 
  984. # allowing nested braces within data fields and ignoring escaped 
  985. # delimiters.  (derived from proc getField).
  986. #
  987. proc getFldValue {entry fldname} {
  988.     set fldPat "\[     \]*${fldname}\[     \]*=\[     \]*"
  989.     set fldPat2 {,[     ]*([^ =,]+)[     ]*=[     ]*}
  990.     set slash "\\"
  991.     set qslash "\\\\"
  992.     
  993.     set ok [regexp -indices -nocase $fldPat $entry mtch]
  994.     if {$ok} {
  995.         set pos [expr [lindex $mtch 1] + 1]
  996.         set entry [string range $entry $pos end]
  997.         
  998.         if {[regexp -indices $fldPat2 $entry mtch sub1]} {
  999.             set entry [string range $entry 0 [expr [lindex $mtch 0]-1]]
  1000.         } 
  1001.         set fld [bibFieldData $entry]
  1002.         
  1003.         return $fld
  1004.         
  1005.     } else {
  1006.         error "field not found"
  1007.     }
  1008. }
  1009.  
  1010. ###########################################################################
  1011. # Parse the entry around position "pos" and rewrite it to the original 
  1012. # buffer in a canonical format
  1013. #
  1014. proc formatEntry {} {
  1015.     global useBrace bibOpenQuote bibCloseQuote 
  1016.     global bibOpenEntry bibCloseEntry bibIndent
  1017.     set spc "                           "
  1018.     
  1019.     bibFormatSetup
  1020.     
  1021.     set pos [getPos]
  1022.     set limits [getEntry $pos]
  1023.     set top [lindex $limits 0]
  1024.     set bottom [lindex $limits 1]
  1025.     
  1026.     if {![catch {bibFormatEntry $pos} result]} {
  1027.         set oldEntry [getText $top $bottom]
  1028.         if {$result != $oldEntry} {
  1029.             deleteText $top $bottom 
  1030.             insertText $result
  1031.         } 
  1032.         goto $top 
  1033.         nextEntry
  1034.     } else {
  1035.         message "Couldn't format this entry for some reason"
  1036.     }
  1037. }
  1038.  
  1039. ###########################################################################
  1040. # Parse the entry around position "pos" and rewrite it to the original 
  1041. # buffer in a canonical format
  1042. #
  1043. proc formatAllEntries {} {
  1044.     global useBrace bibOpenQuote bibCloseQuote 
  1045.     global bibOpenEntry bibCloseEntry bibIndent
  1046.     set spc "                           "
  1047.     
  1048.     bibFormatSetup
  1049.     
  1050.     # This little dance handles the case that the first 
  1051.     # entry starts on the first line
  1052.     #
  1053.     set hit [getEntry [getPos]]
  1054.     if {[lindex $hit 0] == [lindex $hit 1]} {
  1055.         nextEntry
  1056.         set hit [getEntry [getPos]]
  1057.     }
  1058.     
  1059.     while {[getPos] < [lindex $hit 1]} {
  1060.         set top [lindex $hit 0] 
  1061.         set bottom [lindex $hit 1]
  1062.         
  1063.         if {![catch {bibFormatEntry $top} result]} {
  1064.             set oldEntry [getText $top $bottom]
  1065.             if {$result != $oldEntry} {
  1066.                 deleteText $top $bottom 
  1067.                 insertText $result
  1068.             } 
  1069.         }
  1070.         goto $top
  1071.         nextEntry
  1072.         set hit [getEntry [getPos]]
  1073.     }
  1074. }
  1075.  
  1076. ###########################################################################
  1077. # Parse the entry around position "pos" and rewrite it in a canonical format.
  1078. # The formatted entry is returned.
  1079. #
  1080. proc bibFormatEntry {pos} {
  1081.     global useBrace bibOpenQuote bibCloseQuote 
  1082.     global bibOpenEntry bibCloseEntry bibIndent
  1083.     global rqdFld optFld BibmodeVars bibAbbrevs
  1084.     set spc "                           "
  1085.     #    
  1086.     #    note: calling proc must call "bibFormatSetup" before calling "bibFormatEntry"
  1087.     #
  1088.     set limits [getEntry $pos]
  1089.     set top [lindex $limits 0]
  1090.     set bottom [lindex $limits 1]
  1091.  
  1092.     if {[catch {getFields $pos} flds]} {
  1093.         error "bibFormatEntry: Getflds couldn't find any"
  1094.     }
  1095.     
  1096.     set names [lindex $flds 0]
  1097.     set vals [lindex $flds 1]
  1098.     set nfld [llength $names]
  1099.     
  1100.     set type [string tolower [lindex $vals 0]]
  1101.     set citekey [lindex $vals 1]
  1102. #     message "$citekey"
  1103.     # Don't process @string entries
  1104.     if {$type == "string"} {
  1105.         set lines [getText $top $bottom]
  1106.         return $lines
  1107.     }
  1108.     # Find length of longest field name
  1109.     set nmlen 0
  1110.     foreach nm $names {
  1111.         set len [string length $nm]
  1112.         if {$len > $nmlen} { set nmlen $len }
  1113.         if {![info exists useBrace($nm)]} { set useBrace($nm) 0 }
  1114.     }
  1115.     
  1116.     # Format first line
  1117.     set lines "@${type}${bibOpenEntry}${citekey},\r"
  1118.     
  1119.     # Format each field on a separate line
  1120.     for {set ifld 2} {$ifld < $nfld} {incr ifld} { 
  1121.     set nm [lindex $names $ifld]
  1122.     set vl [lindex $vals $ifld]
  1123.     if {$vl != "" || ! $BibmodeVars(zapEmptyFields) || 
  1124.             [lsearch $rqdFld($type) $nm] >= 0} {
  1125.         set pad [expr $nmlen - [string length $nm]]
  1126.         
  1127.         if {$BibmodeVars(alignEquals)} {
  1128.             set pref "${bibIndent}$nm[string range $spc 1 $pad] ="
  1129.         } else {
  1130.             set pref "${bibIndent}$nm =[string range $spc 1 $pad]"
  1131.         }
  1132.         set ind [string range $spc 1 [string length $pref]]
  1133.         
  1134.         # Delimit field, if appropriate
  1135.         set noBrace [expr ($useBrace($nm) == 0 && [isNum $vl]) || [hasCat $vl]]
  1136.         if {$noBrace == 0 && [string first " " $vl] < 0} {
  1137.             set noBrace [expr [lsearch $bibAbbrevs [string tolower $vl]] >= 0]
  1138.         }
  1139.         if {$noBrace != 0} {
  1140.             set vl "$vl,"
  1141.         } else {
  1142.             set vl "${bibOpenQuote}${vl}${bibCloseQuote},"
  1143.         }
  1144.         
  1145.         set pieces [split $vl "\r"]
  1146.         append lines "$pref [lindex $pieces 0]\r"
  1147.         foreach piece [lrange $pieces 1 end] {
  1148.             append lines "$ind  $piece\r"
  1149.         }
  1150.     }
  1151. }
  1152.     append lines "$bibCloseEntry\r"
  1153.     return $lines
  1154. }
  1155.  
  1156. ###########################################################################
  1157. # Get the name of the field that starts before the given position,  
  1158. # $pos.  The positions $top and $bottom restrict the range of the 
  1159. # search for the beginning and end of the field; typically, $top and
  1160. # $bottom will be the limits of a given entry.
  1161. #
  1162. proc getFldName {pos top} {
  1163.     set fldPat {[,     ]+([^     =,\{\}\"\']+)[     ]*=[     ]*}
  1164.     if {![catch {search -f 0 -r 1 -m 0 -i 1 -s -limit $top "$fldPat" $pos} mtch]} {
  1165.         set theText [eval getText $mtch]
  1166.         regexp -nocase $fldPat $theText allofit fldnam
  1167.         return $fldnam
  1168.     } else {
  1169.         return {citekey}
  1170.     }
  1171. }
  1172.  
  1173. ###########################################################################
  1174. #  Set the quote characters for quoted fields based on the value of the 
  1175. #  flag $bibUseBrace
  1176. # 
  1177. proc bibFieldDelims {} {
  1178.     global BibmodeVars bibOpenQuote bibCloseQuote
  1179.     if {$BibmodeVars(fieldBraces)} then {
  1180.         set bibOpenQuote "{"
  1181.         set bibCloseQuote "}" 
  1182.     } else {
  1183.         set bibOpenQuote {"} 
  1184.         set bibCloseQuote {"} 
  1185.     }
  1186. }
  1187.  
  1188. proc bibEntryDelims {} {
  1189.     global BibmodeVars bibOpenEntry bibCloseEntry
  1190.     if {$BibmodeVars(entryBraces)} then {
  1191.         set bibOpenEntry "{"
  1192.         set bibCloseEntry "}" 
  1193.     } else {
  1194.         set bibOpenEntry "("
  1195.         set bibCloseEntry ")"
  1196.     }
  1197. }
  1198.  
  1199. proc isBibFile {} {
  1200.     set fileName [lindex [winNames -f] 0]   
  1201.     set ext [file extension $fileName]
  1202.     return [string match ".bib" [string tolower $ext]] 
  1203. }
  1204.  
  1205. proc hasNumVal {str} {
  1206.     expr ! [catch {expr $str}]
  1207. }
  1208. proc isNum {str} {
  1209.     regexp {^[     ]*[0-9]+[     ]*$} $str mtch
  1210. }
  1211. proc hasCat {str} {
  1212.     regexp {\#} $str mtch
  1213. }
  1214.  
  1215. ###########################################################################
  1216. # Take a list of lists that point to selected entries and copy these into
  1217. # a new window.  The beginning and ending positions for each entry must 
  1218. # be the last two items in each sublist.  The rest of the sublists are
  1219. # ignored.  It is assumed that each sublist has the same number of items.
  1220. #
  1221. proc writeEntries {entryPos nondestructive {beg {0}} {end {-1}}} {
  1222.         global BibmodeVars
  1223.         if {$end < 0} {set end [maxPos]}
  1224.         set llen [expr [llength [lindex $entryPos 0]] - 1]
  1225.         set llen1 [expr $llen-1]
  1226.         foreach entry $entryPos {
  1227.             set limits [lrange $entry $llen1 $llen]
  1228.             append lines [eval getText $limits]
  1229.         }
  1230.         set overwriteOK [expr $nondestructive || ! [isBibFile]]
  1231.         if {$BibmodeVars(overwriteBuffer) && $overwriteOK} {
  1232.             deleteText $beg $end
  1233.             insertText $lines
  1234.             goto $beg
  1235.         } else {
  1236.             set begLines [getText 0 [lineStart $beg]]
  1237.             set endLines [getText [nextLineStart $end] [maxPos]]
  1238.             new -n {*BibTeX Sort/Search*}
  1239.             newMode Bib
  1240.             insertText $begLines
  1241.             insertText $lines
  1242.             insertText $endLines
  1243.             goto $beg
  1244.             setWinInfo dirty 0
  1245.             catch shrinkWindow
  1246.         }
  1247. }
  1248.  
  1249. ###########################################################################
  1250. # Set a named mark for each entry, using the cite-key name
  1251. #
  1252. proc BibMarkFile {} {
  1253.     global BibmodeVars
  1254.      global bibTopPat bibTopPat1 bibTopPat2                                                                                                                        ░La Cie 191:Writing ─:Alpha 6.0b20 ─:Tcl:SystemCode:bibtex.tcl
  1255.     set pos 0
  1256.     while {![catch {search -f 1 -r 1 -m 0 -i 0 -s $bibTopPat1 $pos} res]} {
  1257.         set start [lindex $res 0]
  1258.         set end [nextLineStart $start]
  1259.         set text [getText $start $end]
  1260.         set lab ""
  1261.         if {[regexp $bibTopPat2 $text mtch type citekey]} {
  1262.             if {[string tolower $type] != "string" || $BibmodeVars(markStrings)} { 
  1263.                 setNamedMark $citekey [lineStart [expr $start - 1]] $start $start
  1264.             }
  1265.         }
  1266.         set pos $end
  1267.     }
  1268. }
  1269.  
  1270. ###########################################################################
  1271. # Report the number of entries of each type
  1272. #
  1273. proc countEntries {} {
  1274.     global entryNames
  1275.      global bibTopPat bibTopPat1 bibTopPat2                                                                                                                        ░La Cie 191:Writing ─:Alpha 6.0b20 ─:Tcl:SystemCode:bibtex.tcl
  1276.     
  1277.     set pos 0
  1278.     set count 0
  1279.     catch {unset type}
  1280.     
  1281.     while {![catch {search -f 1 -r 1 -m 0 -i 0 -s $bibTopPat $pos} res]} {
  1282.         incr count
  1283.         set start [lindex $res 0]
  1284.         set end [nextLineStart $start]
  1285.         set text [getText $start $end]
  1286.         set lab ""
  1287.         if {[regexp $bibTopPat $text mtch entryType]} {
  1288.             set entryType [string tolower $entryType]
  1289.             if {[catch {incr type($entryType)} num]} {
  1290.                 set type($entryType) 1
  1291.             }
  1292.         }
  1293.         set pos $end
  1294.     }
  1295.     new -n {*BibTeX Statistics*}
  1296.     newMode Bib
  1297.     foreach name [lsort [array names type]] {
  1298.         if {$type($name) > 0} {
  1299.             append lines [format "%4.0d  %s\n" $type($name) $name]
  1300.         }
  1301.     }
  1302.     append lines "----  -----------------\n"
  1303.     append lines [format "%4.0d  %s\n" $count "Total entries"]
  1304.     insertText $lines
  1305.     goto 0
  1306.     setWinInfo dirty 0
  1307.     catch {shrinkWindow 1}
  1308. }
  1309. #--------------------------------------------------------------------------
  1310. # command-double-clicking:
  1311. #--------------------------------------------------------------------------
  1312.  
  1313. ###########################################################################
  1314. # In Bib mode, Cmd-double-clicks resolve abbrevs and cross-refs
  1315. #
  1316. proc BibDblClick {from to} {
  1317.     global bibTopPat bibTopPat1 bibTopPat2
  1318.     
  1319.     set limits [getEntry $from]
  1320.     set top [lindex $limits 0]
  1321.     set bottom [lindex $limits 1]
  1322.  
  1323.     # Extend selection to largest string that could be an entry reference
  1324.     set text [string trim [eval getText [BibExtendClick $from $to $top $bottom]]]
  1325.     
  1326.     # Get the citekey of current entry, so we can avoid jumping to it    
  1327.     set citekey {}
  1328.     regexp $bibTopPat2 [getText $top $bottom] mtch type citekey ]
  1329.     set fldName [getFldName $from $top]
  1330.  
  1331.     if {[string length $text] == 0 || $text == $citekey || $fldName == $text || 
  1332.         ($fldName == "citekey" && [string tolower $type] != "string")} {
  1333.         message "Command-double-click on abbreviations and crossref arguments"
  1334.         return
  1335.     }
  1336.  
  1337.     # Jump to the mark for the specified citation, if a mark exists...
  1338.     # ...otherwise, do an ordinary search for the cite key
  1339.     pushMark    
  1340.     set searchPat "$bibTopPat\[     \]*[quoteExpr $text]\[     ,\}\)\]"
  1341.     if {![catch {search -f 1 -r 1 -i 1 -m 0 $searchPat 0} mtch]} {
  1342.         goto [lindex $mtch 0]
  1343.     } else {
  1344.         popMark
  1345.         select $from $to
  1346.         if {$fldName == "crossref"} {
  1347.             message "Cross-reference \"$text\" not found"
  1348.         } else {
  1349.             message "Command-double-click on abbreviations and crossref arguments"
  1350.         }
  1351.         return
  1352.     }
  1353.     message "Use Ctl-. to return to original position"
  1354.     return
  1355. }
  1356.  
  1357. # Extend the selection around the initial selection {$from,$to}
  1358. # Extension is restricted to the range {$top,$bottom} (the current entry)
  1359. proc BibExtendClick {from to top bottom} {
  1360.     if {$to == 0} { set to $from }
  1361.     set result [list $from $to]
  1362.     if {![catch {search -f 0 -r 1 -s -m 0 -l $top "\[,\{\]\"\'=" $from} mtch0]} {
  1363.         if {![catch {search -f 1 -r 1 -s -m 0 -l $bottom "\[,\}\]\"\'=" $to} mtch1]} {
  1364.             set from [lindex $mtch0 1]
  1365.             set to [lindex $mtch1 0]
  1366.             # Check for illegal chars embedded in the selection
  1367.             if {[regexp "\[\{\}\]=" [getText $from $to]] == 0} {
  1368.                 set result [list $from $to]
  1369.             }
  1370.         }
  1371.     }
  1372.     return $result
  1373. }
  1374.  
  1375.  
  1376. ###########################################################################
  1377.  
  1378. proc dummyBibTeX {} {
  1379.     global BibmodeVars TeXmodeVars
  1380. #     if {$BibmodeVars(convert8bitAscii2TeX) != $TeXmodeVars(convert8bitAscii2TeX)} {
  1381. #         set BibmodeVars(convert8bitAscii2TeX) $TeXmodeVars(convert8bitAscii2TeX)
  1382. #     }    
  1383. }
  1384.  
  1385. #